<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: xsecure_keyunwrap.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsecure__keyunwrap_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsecure_keyunwrap.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains Versal Net specific code for Xilsecure key unwrap. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
5.2   kpt     06/30/23 Initial release
      dd      10/11/23 MISRA-C violation Rule 10.4 fixed
      dd      10/11/23 MISRA-C violation Rule 8.13 fixed
5.3   kpt     11/24/23 Replace Xil_SMemSet with Xil_SecureZeroize
      kpt     12/13/23 Added support for RSA CRT
      kpt     12/13/23 Added SHA384 MGF support for keyunwrap
      kpt     12/19/23 Fix logical issue in updating keyslot value
5.3   ng      01/28/24 Added SDT support
      ng      03/26/24 Fixed header include in SDT flow
5.4   yog     04/29/24 Fixed doxygen warnings.
      kpt     06/13/24 Added RSA key generation support.
      kpt     06/13/24 Added AES key unwrap with padding support.
      kpt     06/13/24 Updated keyvault map.
      kal     07/24/24 Code refactoring for versal_2ve_2vm</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga9ca0cf20d44fa54519566ff4360154f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#ga9ca0cf20d44fa54519566ff4360154f0">XSECURE_MAX_KEY_STORE_CAPACTIY</a>&#160;&#160;&#160;(32U)</td></tr>
<tr class="memdesc:ga9ca0cf20d44fa54519566ff4360154f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum key store capacity.  <a href="group__xsecure__keyunwrap__server__apis.html#ga9ca0cf20d44fa54519566ff4360154f0">More...</a><br/></td></tr>
<tr class="separator:ga9ca0cf20d44fa54519566ff4360154f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaacb4b7c562037f76ce135fd2659024b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#gaacb4b7c562037f76ce135fd2659024b4">XSECURE_SHARED_KEY_STORE_SIZE_OFFSET</a>&#160;&#160;&#160;(8U)</td></tr>
<tr class="memdesc:gaacb4b7c562037f76ce135fd2659024b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key size offset.  <a href="group__xsecure__keyunwrap__server__apis.html#gaacb4b7c562037f76ce135fd2659024b4">More...</a><br/></td></tr>
<tr class="separator:gaacb4b7c562037f76ce135fd2659024b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a82817e5b3bf270ed1e31200603742f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#ga6a82817e5b3bf270ed1e31200603742f">XSECURE_KEY_STORE_KEY_OFFSET</a>&#160;&#160;&#160;(4U)</td></tr>
<tr class="memdesc:ga6a82817e5b3bf270ed1e31200603742f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key offset from key slot status.  <a href="group__xsecure__keyunwrap__server__apis.html#ga6a82817e5b3bf270ed1e31200603742f">More...</a><br/></td></tr>
<tr class="separator:ga6a82817e5b3bf270ed1e31200603742f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a1499e52c8b2b547996df177d08dad4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#ga7a1499e52c8b2b547996df177d08dad4">XSECURE_AES_256BIT_KEY_BLOCK_SIZE</a>&#160;&#160;&#160;(40U)</td></tr>
<tr class="memdesc:ga7a1499e52c8b2b547996df177d08dad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES 256-bit key block size.  <a href="group__xsecure__keyunwrap__server__apis.html#ga7a1499e52c8b2b547996df177d08dad4">More...</a><br/></td></tr>
<tr class="separator:ga7a1499e52c8b2b547996df177d08dad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa701b146b5ca0fcc10c4540285282dd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#gaaa701b146b5ca0fcc10c4540285282dd">XSECURE_AES_128BIT_KEY_BLOCK_SIZE</a>&#160;&#160;&#160;(24U)</td></tr>
<tr class="memdesc:gaaa701b146b5ca0fcc10c4540285282dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES 128-bit key block size.  <a href="group__xsecure__keyunwrap__server__apis.html#gaaa701b146b5ca0fcc10c4540285282dd">More...</a><br/></td></tr>
<tr class="separator:gaaa701b146b5ca0fcc10c4540285282dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e1d11a69ab8605cea40a370c6bacb07"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#ga6e1d11a69ab8605cea40a370c6bacb07">XSECURE_AES_KEY_SLOT_STATUS_FULL</a>&#160;&#160;&#160;(0x973AFB51U)</td></tr>
<tr class="memdesc:ga6e1d11a69ab8605cea40a370c6bacb07"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES key status is full.  <a href="group__xsecure__keyunwrap__server__apis.html#ga6e1d11a69ab8605cea40a370c6bacb07">More...</a><br/></td></tr>
<tr class="separator:ga6e1d11a69ab8605cea40a370c6bacb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf1df351e91ee42e7c281b2e676ffda7b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__keyunwrap__server__apis.html#gaf1df351e91ee42e7c281b2e676ffda7b">XSecure_KeyUnwrap</a> (<a class="el" href="struct_x_secure___key_wrap_data.html">XSecure_KeyWrapData</a> *KeyWrapData)</td></tr>
<tr class="memdesc:gaf1df351e91ee42e7c281b2e676ffda7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function unwraps the given wrapped key and stores it along with metadata in Shared address between PMC and secure shell.  <a href="group__xsecure__keyunwrap__server__apis.html#gaf1df351e91ee42e7c281b2e676ffda7b">More...</a><br/></td></tr>
<tr class="separator:gaf1df351e91ee42e7c281b2e676ffda7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
